DigiOffice Gateway Web Services

<back to all web services

GetProjectDetailsTBI

Get project details

Requires Authentication
The following routes are available for this service:
GET/api/tbi/Projects/{ID}

export class Veld
{
    public Name: string;
    public Type: string;
    public Value: Object;
    public Description: string;
    public GlobalID?: string;

    public constructor(init?: Partial<Veld>) { (Object as any).assign(this, init); }
}

export class ProjectDetailsTBI
{
    public Velden: Veld[];

    public constructor(init?: Partial<ProjectDetailsTBI>) { (Object as any).assign(this, init); }
}

/** @description Get project details */
// @Api(Description="Get project details")
export class GetProjectDetailsTBI
{
    /** @description ID or GlobalID */
    // @ApiMember(Description="ID or GlobalID", IsRequired=true)
    public ID: string;

    public constructor(init?: Partial<GetProjectDetailsTBI>) { (Object as any).assign(this, init); }
}

TypeScript GetProjectDetailsTBI DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/tbi/Projects/{ID} HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectDetailsTBI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.API.TBI.API.DTO">
  <Velden>
    <Veld>
      <Description>String</Description>
      <GlobalID>00000000-0000-0000-0000-000000000000</GlobalID>
      <Name>String</Name>
      <Type>String</Type>
      <Value />
    </Veld>
  </Velden>
</ProjectDetailsTBI>